﻿//  Copyright 2021 Google Inc. All Rights Reserved.
//
//  Licensed under the Apache License, Version 2.0 (the "License");
//  you may not use this file except in compliance with the License.
//  You may obtain a copy of the License at
//
//  http://www.apache.org/licenses/LICENSE-2.0
//
//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS,
//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//  See the License for the specific language governing permissions and
//  limitations under the License.

namespace NtCoreLib.Utilities.Text;

/// <summary>
/// A single extract string instance.
/// </summary>
public struct ExtractedString
{
    /// <summary>
    /// The string value.
    /// </summary>
    public string Value { get; }
    /// <summary>
    /// The offset in the buffer.
    /// </summary>
    public long Offset { get; }
    /// <summary>
    /// True if the string was 16-bit Unicode.
    /// </summary>
    public ExtractedStringType Type { get; }
    /// <summary>
    /// Source of the string. Empty if was from a byte array.
    /// </summary>
    public string Source { get; }

    internal ExtractedString(string value, long offset, ExtractedStringType type, string source)
    {
        Value = value;
        Offset = offset;
        Type = type;
        Source = source;
    }

    /// <summary>
    /// Overridden ToString method.
    /// </summary>
    /// <returns>The value of the extracted string.</returns>
    public override string ToString()
    {
        return Value;
    }
}
